fix(opentelemetry): attributes missing on validation errors #1530

EmrysMyrddin · 2025-09-19T13:32:41Z

No description provided.

Copilot

Pull Request Overview

This PR fixes missing attributes on validation errors in OpenTelemetry spans by restructuring how GraphQL operation attributes are set during different phases of query processing.

Key changes:

Refactored attribute setting to ensure operation metadata is available during validation errors
Added proper error code collection and attribute setting for validation spans
Enhanced test coverage for validation error scenarios with Hive tracing

Reviewed Changes

Copilot reviewed 6 out of 6 changed files in this pull request and generated 4 comments.

Show a summary per file

File	Description
packages/plugins/opentelemetry/tests/utils.ts	Updates test utilities to support custom tracer providers and switches from proxy to supergraph configuration
packages/plugins/opentelemetry/tests/useOpenTelemetry.spec.ts	Adds validation error test case and updates existing tests for new supergraph setup
packages/plugins/opentelemetry/src/spans.ts	Refactors attribute setting functions and adds operation caching mechanism
packages/plugins/opentelemetry/src/plugin.ts	Updates plugin hooks to properly set attributes during validation and execution phases
e2e/opentelemetry/opentelemetry.e2e.ts	Adds focused end-to-end test for validation error telemetry
e2e/opentelemetry/gateway.config.ts	Adds alternative configuration setup for testing

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}

Copilot · 2025-09-23T19:40:43Z

packages/plugins/opentelemetry/tests/useOpenTelemetry.spec.ts

+        operationSpan.span.attributes['graphql.operation.name'] === 'test';
+        operationSpan.span.attributes['graphql.operation.type'] === 'query';
+        operationSpan.span.attributes['hive.graphql.error.count'] === 1;


These lines are using assignment operators (===) instead of assertions. They should use expect() assertions to actually test the values.

Suggested change

operationSpan.span.attributes['graphql.operation.name'] === 'test';

operationSpan.span.attributes['graphql.operation.type'] === 'query';

operationSpan.span.attributes['hive.graphql.error.count'] === 1;

expect(operationSpan.span.attributes['graphql.operation.name']).toBe('test');

expect(operationSpan.span.attributes['graphql.operation.type']).toBe('query');

expect(operationSpan.span.attributes['hive.graphql.error.count']).toBe(1);

Copilot · 2025-09-23T19:40:44Z

packages/plugins/opentelemetry/src/spans.ts


+    const codes = [];
    for (const error of result) {
+      if (error.extensions.code) {


Potential runtime error if error.extensions is undefined. Should check if error.extensions exists before accessing the code property.

Suggested change

if (error.extensions.code) {

if (error.extensions && error.extensions.code) {

Copilot · 2025-09-23T19:40:44Z

packages/plugins/opentelemetry/src/spans.ts

+      document,
+      operationName || undefined,
+    );
+  } catch {}


Empty catch block suppresses all errors silently. Consider logging the error or adding a comment explaining why errors should be ignored here.

Suggested change

} catch {}

} catch (err) {

// Failed to get operation AST from document; log error for debugging.

console.error('Error in getOperationFromDocument:', err);

}

Copilot · 2025-09-23T19:40:45Z

packages/plugins/opentelemetry/src/spans.ts

 import {
  getOperationASTFromDocument,
  isAsyncIterable,
+  memoize2,


The memoize2 import is added but never used in this file. This unused import should be removed.

Suggested change

memoize2,

theguild-bot · 2025-09-26T15:37:41Z

🚀 Snapshot Release (`alpha`)

The latest changes of this PR are available as alpha on npm (based on the declared changesets):

Package	Version	Info
`@graphql-hive/gateway`	`2.1.10-alpha-1840765d92a74f7cc279061328104c5ea7b4df49`	npm ↗︎ unpkg ↗︎
`@graphql-hive/nestjs`	`2.0.15-alpha-1840765d92a74f7cc279061328104c5ea7b4df49`	npm ↗︎ unpkg ↗︎
`@graphql-hive/plugin-opentelemetry`	`1.0.12-alpha-1840765d92a74f7cc279061328104c5ea7b4df49`	npm ↗︎ unpkg ↗︎
`@graphql-mesh/plugin-prometheus`	`2.0.13-alpha-1840765d92a74f7cc279061328104c5ea7b4df49`	npm ↗︎ unpkg ↗︎
`@graphql-hive/gateway-runtime`	`2.1.9-alpha-1840765d92a74f7cc279061328104c5ea7b4df49`	npm ↗︎ unpkg ↗︎

theguild-bot · 2025-09-26T15:41:04Z

🚀 Snapshot Release (Binary for `Linux-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-09-26T15:41:07Z

🚀 Snapshot Release (Binary for `macOS-ARM64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-09-26T15:41:23Z

🚀 Snapshot Release (Binary for `Linux-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-09-26T15:45:45Z

🚀 Snapshot Release (Binary for `Windows-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

theguild-bot · 2025-09-26T15:48:37Z

🚀 Snapshot Release (Node Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.6-alpha-d1575658d7a2e204c8610225399ba836a8f3c9ac

theguild-bot · 2025-09-26T15:49:23Z

🚀 Snapshot Release (Bun Docker Image)

The latest changes of this PR are available as image on GitHub Container Registry (based on the declared changesets):

ghcr.io/graphql-hive/gateway:2.1.6-alpha-d1575658d7a2e204c8610225399ba836a8f3c9ac-bun

theguild-bot · 2025-09-26T15:50:52Z

🚀 Snapshot Release (Binary for `macOS-X64`)

The latest changes of this PR are available for download (based on the declared changesets).

n1ru4l

Works!

EmrysMyrddin force-pushed the repro/otel/bad-validation-error-handling branch from 529318e to 627a488 Compare September 23, 2025 19:20

EmrysMyrddin changed the title ~~added test for validation errors~~ fix(opentelemetry): attributes missing on validation errors Sep 23, 2025

EmrysMyrddin marked this pull request as ready for review September 23, 2025 19:39

Copilot AI review requested due to automatic review settings September 23, 2025 19:39

Copilot AI reviewed Sep 23, 2025

View reviewed changes

EmrysMyrddin force-pushed the repro/otel/bad-validation-error-handling branch from 1a5b4c6 to eab949a Compare September 26, 2025 15:38

EmrysMyrddin marked this pull request as draft September 26, 2025 15:56

n1ru4l self-requested a review October 8, 2025 13:21

n1ru4l approved these changes Oct 8, 2025

View reviewed changes

EmrysMyrddin marked this pull request as ready for review October 8, 2025 17:23

EmrysMyrddin added 12 commits October 9, 2025 11:34

added test for validation errors

1d4bc28

fix

24908a7

fix lint

93df5ad

fix linter

d92e8e6

add comment

8e1e895

copy error count and code for parse, validate and execute

c5a25e8

fix lint

ca96176

remove comments

36878dd

remove .only

5265aad

fix extension can be undefined

35741e4

add attribute for console to identify operation root span

675c2e6

add tests for hive root span attribute

5dcdfc4

prettier

1840765

EmrysMyrddin force-pushed the repro/otel/bad-validation-error-handling branch from d157565 to 1840765 Compare October 9, 2025 09:34

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

Uh oh!

fix(opentelemetry): attributes missing on validation errors #1530

fix(opentelemetry): attributes missing on validation errors #1530

EmrysMyrddin commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

Copilot AI Sep 23, 2025

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

Uh oh!

n1ru4l left a comment

Uh oh!

Uh oh!

	if (error.extensions.code) {
	if (error.extensions && error.extensions.code) {

-  } catch {}
+  } catch (err) {
+    // Failed to get operation AST from document; log error for debugging.
+    console.error('Error in getOperationFromDocument:', err);
+  }

fix(opentelemetry): attributes missing on validation errors #1530

Are you sure you want to change the base?

fix(opentelemetry): attributes missing on validation errors #1530

Conversation

EmrysMyrddin commented Sep 19, 2025

Uh oh!

Copilot AI left a comment

Choose a reason for hiding this comment

Pull Request Overview

Reviewed Changes

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

Copilot AI Sep 23, 2025

Choose a reason for hiding this comment

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (alpha)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-ARM64)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-ARM64)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Linux-X64)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for Windows-X64)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Node Docker Image)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Bun Docker Image)

Uh oh!

theguild-bot commented Sep 26, 2025 • edited Loading Uh oh! There was an error while loading. Please reload this page.

Uh oh!

🚀 Snapshot Release (Binary for macOS-X64)

Uh oh!

n1ru4l left a comment

Choose a reason for hiding this comment

Uh oh!

Uh oh!

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (`alpha`)

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-ARM64`)

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-ARM64`)

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Linux-X64`)

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `Windows-X64`)

theguild-bot commented Sep 26, 2025 •

edited

Loading

theguild-bot commented Sep 26, 2025 •

edited

Loading

theguild-bot commented Sep 26, 2025 •

edited

Loading

🚀 Snapshot Release (Binary for `macOS-X64`)